Remove 'extra_css_files' #450
Conversation
`extra_css_files` was add in readthedocs/readthedocs.org@e759c50 but serves no purpose (not sure why it was added intially) users should use `Sphinx.add_stylesheet` instead.
agjohnson
added
the
PR: work in progress
|
Actually looking at this there are several projects that use this. Is there a way to mark this as deprecated? |
Blendify
added
Needed: design decision
|
Yeah, this is still in use by forks, so I wouldn't want to deprecate it either. |
|
Well, this is used for add style sheets, which might be required to fine-tune the appearance where rst is coming to its limits. |
|
This should still be removed to conform sphinx's new method for adding css files. https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_css_files This can be removed when we require sphinx2, there does not seem the be a way to deprecate this first. |
Blendify
removed
Needed: design decision
|
I think we can target this for 3.0 and start raising a warning on 2.x. |
|
I just wanted to note that we had some issues when releasing 2.0 because of this chunk of code. I'm fine removing this since it adds no value over the built-in Sphinx feature. |
|
Updated the branch and waiting on approval for 2.0 |
|
Thanks for the update @Blendify. I don't think we will include this in 2.0 since we are on |
|
We definitely need to do a deprecation warning before removing an option like this. Though this is a configuration we shouldn't have added, I also personally don't see much value in a deprecation like this given it's such a sideways change -- the code here isn't really presenting a problem for our maintenance and the user is not really better off being forced to change either. If we do a deprecation in 3.0, we should emit a deprecation warning starting in 2.0 |
* Tests: `sphinxdev` tox environment installs Sphinx from `master` It seems we had a bug in the name and it wasn't installing Sphinx from `master`. I expect this test to fail now because we pin `Sphinx<8`, but that's fine for now. * Prepare for 3.0 release - Drop Python <3.8 - Drop docutils <=0.18 - Add support for docutils 0.21 - Add support for Python 3.12 This follows the plan we wrote in https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#roadmap-release-3-0-0 The main idea here is to move forward with newer versions and drop support for old stuffs so we reduce the maintanence burden. * Update CircleCI matrix * More fixes to CircleCI * Run test over Sphinx 8.0 * Update contributing guide * Remove deprecated `readthedocs-sphinx-ext` * Remove old Sphinx versions * Uninstall our extension * Show a warning if `extra_css_files` is in the `html_context` See #450 * Update development page * Add deprecate warning for `analytics_` theme options * Update docs * Remove unused dependency Closes #1533 * Remove environment variables from our docs This was already added in a more generic way to the theme itself. * Require Sphinx >=6.0 * Deprecation warning about `get_html_theme_path` See #1479 (comment)
extra_css_fileswas add in readthedocs/readthedocs.org@e759c50 but serves no purpose (not sure why it was added intially) users should useSphinx.add_stylesheetinstead.